NZPost.AddressChecker

Resource URL

UAT:

http://api.uat.nzpost.co.nz/addresschecker/1.0/suggest

Production:

https://api.nzpost.co.nz/addresschecker/1.0/suggest

Resource Description

Takes an address fragment, and returns a set of addresses that match the fragment.

Resource Information

Attribute	Detail
Response Format	JSON
Requires Authentication	Yes
Rate Limited	15 calls per second. If rate limit is exceeded, calls will be queued. Calls unprocessed for over 60 seconds will time out.

Please note that all request parameters should be in lower case.

Request Parameters

Field Name	Description	Value	Required	Example
q	Address fragment to query	String	Yes	8 water
max	Maximum number of results to return (default: 10)	Integer	No	5

Request Headers

Following headers need to be passed on to the API call.

Header Details

Key	Value
Accept	application/json
Authentication	Bearer (token)

Sample Request

https://api.nzpost.co.nz/addresschecker/1.0/suggest?q=8+water&max=50

Response Parameters

Field Name	Description	Value	Required	Example
success	Indicates if the request succeeded or not	Boolean	Yes	true
addresses	Contains array of address objects. The number of object will not exceed the 'max' value defined.	Array	Yes if success = true	See Address Object below
status	Status of the request.	String	Yes	success

Addresses Object

Field Name	Description	Value	Required	Example
DPID	Unique NZ Post identifier	Integer	Yes	109570
SourceDesc	Address Ref Dataset source category text	String	Yes	Postal\\Physical
FullAddress	Full address format	String	Yes	8 Water Lane, New Plymouth 4310

Sample Response